8  Release Package & User Guides

8.1 Deliverable Package

8.1.1 Source Codes & Documents

No.	Items	Sub-Items	Type	Version
Code package
1	EduBlock	EduBlock Client	New	1.0
2	Blockchain Network	Blockchain Chaincode	New	1.0
3	OCR	Record Table Processor	New	1.0
Database
1	Tables	accounts.sql	New	1.0
		classrooms.sql	New	1.0
		subjects.sql	New	1.0
Documents
1	Requirement	SRS_v1.0.docx	New	1.0
2	Deployment	UserGuide_v1.0.docx	New	1.0

8.1.2 Known Issues, Limitations & Restrictions

8.2 Installation Guides

8.2.1 System Requirements

OS: any

CPU: at least 4 cores

RAM: at least 4Gb

NETWORK: required

SOFTWARE: Docker

8.2.2 Setup Files

• Dockerfile.backend
• Dockerfile.frontend
• Dockerfile.ocr

8.2.3 Installation Instruction

8.3 User Manual

8.3.1 Terms & Definitions

No.	Term	Definition
01	F.FT	Feature
02	R.ADM	Admin
03	R.STF	Staff
04	R.TCH	Teacher
05	R.STD	Student
06	R.ANY	Any role

8.3.2 System Requirements

OS: any

CPU: any

RAM: at least 1Gb

NETWORK: required

8.3.3 Application Usage

8.3.3.1 Overview

No.	Feature	Role	Note
01	Create new account	R.ADM
02	View account list	R.ADM, R.STF
03	View profile	R.ANY	Each role have different behavior
04	Update profile	R.ADM, R.STF	Each role have different behavior
05	Update password	R.ANY	Each role have different behavior
06	Create new classroom	R.STF
07	View classroom list	R.STF, R.TCH, R.STD	Each role have different behavior
08	View classroom information	R.STF, R.TCH, R.STD
09	View students of classroom	R.STF, R.TCH, R.STD
10	View teachers of classroom	R.STF, R.TCH, R.STD
11	Update classroom information	R.STF
12	Update student in classroom	R.STF
13	Update teacher in classroom	R.STF
14	View update request list	R.TCH
15	Verify update request	R.TCH
16	Request update record	R.TCH, R.STD

8.3.3.2 Feature 01: Create new account

Description:

• Admin create account for other user usage

Details:

• R.ADM
  • Step 1: Click Account on the left navigation bar to navigate to account list page
  • Step 2: Click Create at the top left of the page to open a modal with form
  • Step 3: Input user First name, Last name and select a role for user
  • Step 4: (Optional) Click Add at the bottom left of the form to add more account and repeat from Step 1
  • Step 5: Click Create at the bottom right of the form to confirm the account creation

8.3.3.3 Feature 02: View account list

Description:

• Admin, Staff view the account list to manage account information and find reference for other operations

Details:

• R.ADM
  • Step 1: Click Account on the left navigation bar to navigate to account list page
  • Step 2: (Optional) Click Search to reveal filter options below
  • Step 2.1: Select search field on the left
  • Step 2.2: Input search text on the right
  • Step 2.3: Click Search button at the right most to apply list filter
  • Step 3: View list of account
  • Step 4: (Optional) Click page number at the top right to view other accounts

8.3.3.4 Feature 03: View profile

Description:

• Admin, Staff view user profile
• User view personal profile

Details:

• R.ANY (Personal)
  • Step 1: Click personal card at the bottom of the Vertical Navigation bar to navigate to the profile page
• R.ADM, R.STF
  • Step 1: Click Account on the left navigation bar to navigate to account list page
  • Step 2: Look for the specific account row in table
  • Step 3: Click Details in the Actions column to navigate to the profile page of that account

8.3.3.5 Feature 04: Update profile

Description:

• Admin, Staff update personal profile
• Staff update Teacher, Student profile

Details

• R.ADM, R.STF (Personal)
  • Step 1: Click personal card at the bottom of the Vertical Navigation bar to navigate to the profile page
  • Step 2: Click Update in the profile section to open a modal with form
  • Step 3: Change the form data to desired value
  • Step 4: Click Confirm to save the changes.
• R.STF
  • Step 1: Click Account on the left navigation bar to navigate to account list page
  • Step 2: Look for the specific account row in table
  • Step 3: Click Update in the Actions column to open an update modal with form
  • Step 4: Change the form data to desired value
  • Step 5: Click Confirm to save the changes

8.3.3.6 Feature 05: Update password

Description:

• Admin update other user password
• User self update password

Details

• R.ANY (Personal)
  • Step 1: Click personal card at the bottom of the Vertical Navigation bar to navigate to the profile page
  • Step 2: Click Update password at the top right of the page to open a modal with form
  • Step 3: Input the new password
  • Step 4: Click Confirm to save the new password
• R.ADM
  • Step 1: Click Account on the left navigation bar to navigate to account list page
  • Step 2: Look for the specific account row in table
  • Step 3: Click Update password in the Actions column to open an update modal with form
  • Step 4: Input the new password
  • Step 5: Click Confirm to save the new password

8.3.3.7 Feature 06: Create new classroom

Description:

• Staff Create new classroom in the system

Details

• R.STF
  • Step 1: Click Classroom on the left navigation bar to navigate to classroom list page
  • Step 2: Click Create at the top left of the page to open a modal with form
  • Step 3: Change the form data to desired value
  • Step 4: Click Confirm at the bottom right of the modal to save the created classroom

8.3.3.8 Feature 07: View classroom list

Description:

• Staff view the list of all the classroom in the system
• Teacher view the list of all the classroom being taught by that teacher
• Student view the list of all the classroom that student taking part in

Details

• R.STF
  • Step 1: Click Classroom on the left navigation bar to navigate to classroom list page
• R.TCH, R.STD
  • Step 1: The list of classroom is in the dashboard page

8.3.3.9 Feature 08: View classroom information

Description:

• Staff view classroom information
• Teacher view information of the classroom being taught by that teacher
• Student view information of the classroom that student taking part in

Details

• R.STF
  • Step 1: Click Classroom on the left navigation bar to navigate to classroom list page
  • Step 2: Look for the specific classroom row in table
  • Step 3: Click Details in the Actions column to navigate to the classroom details page
• R.TCH, R.STD
  • Step 1: Click Dashboard on the left navigation bar to navigate to classroom list page
  • Step 2: Look for the specific classroom row in table
  • Step 3: Click Details in the Actions column to navigate to the classroom information page

8.3.3.10 Feature 09: View students of classroom

Description:

• Staff view all the student in a specific classroom
• Teacher view all the student in the classroom being taught by that teacher
• Student view all the student in the classroom that student taking part in

Details

• R.STF, R.TCH, R.STD
  • Step 1: Follow Feature 08 to navigate to the classroom information page
  • Step 2: Click Student which is the center tab at the top of the page to navigate to student list of that classroom

8.3.3.11 Feature 10: View teachers of classroom

Description:

• Staff view all the teacher in a specific classroom
• Teacher view all the teacher in the classroom being taught by that teacher
• Student view all the teacher in the classroom that student taking part in

Details

• R.STF, R.TCH, R.STD
  • Step 1: Follow Feature 08 to navigate to the classroom information page
  • Step 2: Click Teacher which is right most tab at the top of the page to navigate to teacher list of that classroom

8.3.3.12 Feature 11: Update classroom information

Description:

• Staff update a specific classroom information

Details

• R.STF
  • Step 1: Follow Feature 08 to navigate to the classroom information page
  • Step 2: Click Details which is right most tab at the top of the page to navigate to details page of that classroom
  • Step 3: Click Update at the bottom of the page to open a modal with form
  • Step 4: Change the form data to desired value
  • Step 5: Click Confirm at the bottom of the modal to save changes

8.3.3.13 Feature 12: Update student in classroom

Description:

• Staff change the student of a specific classroom

Details

• R.STF
  • Step 1: Follow Feature 09 to navigate to the classroom student page
  • Step 2: Look for a specific account row in the table (May skip to Step 4)
  • Step 3: Click Remove in the Actions column to remove student from classroom
  • Step 4: Click Add at the top left of the page to open a modal with form
  • Step 5: Change the form data to desired value
  • Step 6: Click Confirm at the bottom right of the modal to save changes

8.3.3.14 Feature 13: Update teacher in classroom

Description:

• Staff change the teacher of a specific classroom

Details

• R.STF
  • Step 1: Follow Feature 10 to navigate to the classroom teacher page
  • Step 2: Look for a specific account row in the table (May skip to Step 4)
  • Step 3: Click Remove in the Actions column to remove teacher from classroom
  • Step 4: Click Add at the top left of the page to open a modal with form
  • Step 5: Change the form data to desired value
  • Step 6: Click Confirm at the bottom right of the modal to save changes

8.3.3.15 Feature 14: View update request list

Description:

• Teacher view list of request for updating record value

Details

• R.TCH
  • Step 1: Click Request on the left navigation bar to navigate to request list page

8.3.3.16 Feature 15: Verify update request

Description:

• Teacher verify request waiting for verification

Details

• R.TCH
  • Step 1: Follow Feature 14 to navigate to the request list page
  • Step 2: Look for the specific request row in table
  • Step 3: Click Approve or Reject to approve or reject the request

8.3.3.17 Feature 16: Request update record

Description:

• Teacher or student of same classroom request updating record for that student

Details

• R.TCH
  • Step 1: Follow Feature 09 to navigate to student profile page
  • Step 2: Look for the record need update in the record table at the bottom of the page
  • Step 3: Click Update in the Actions column to open a modal with form
  • Step 4: Change the form data to desired value
  • Step 5: Click Confirm to send the request
• R.STD
  • Step 1: Click personal card at the bottom of the Vertical Navigation bar to navigate to the profile page
  • Step 2: Look for the record need update in the record table at the bottom of the page
  • Step 3: Click Update in the Actions column to open a modal with form
  • Step 4: Change the form data to desired value
  • Step 5: Click Confirm to send the request

8.3.4 Troubleshooting